home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / comm / thor12.zip / THOR.LHA / rexx / addevent.thor next >
Text File  |  1994-03-03  |  4KB  |  98 lines
  1. /*
  2. **     addevent.thor - add an event to the given BBS.
  3. **
  4. **    Will return 10 if the BBS given was unknown, the arguments given 
  5. **  was incorrect, or the event failed for some other reason (e.g. 
  6. **  the event isn't supported on this BBS type), and 0 on success.
  7. **
  8. **    Template:
  9. **
  10. **    BBSNAME=BBS/A        - The name of the BBS to add this event to
  11. **    EVENT/A                - The name of the event to add to the given BBS.
  12. **                          (see detailed description on the events 
  13. **                          supported further down).
  14. **    SENDTO/K            - Name of a person.
  15. **    C=CONF/K            - Conference
  16. **    REPLYTO/K            - If EVENT is REPLYMSG, this will contain the
  17. **                          message number of the message to send a reply
  18. **                          to.  NOTE: The number is the internal number
  19. **                          kept in THOR, and NOT the real number as seen
  20. **                          on the BBS.
  21. **    BBSREPLYTO/K        - The real number of the message as seen on the
  22. **                          BBS.
  23. **    MSGFILE/K            - This is the filename of the text file to be 
  24. **                          used with ENTERMSG and REPLYMSG. Must include
  25. **                          full path, and this file will be copied into
  26. **                          the given BBS' directory in BBSDATA: before the 
  27. **                          the event is added.
  28. **    SUBJECT=SUB/K        - The subject of a message.
  29. **    P=PRIVATE/K/S        - If this argument is used, the event will be
  30. **                          private to SENDTO. 
  31. **    FILENAME=FILE/K        - The filename to be used on UPLOAD and DOWNLOAD.
  32. **                          On UPLOAD, this is the name that the file will
  33. **                          appear with on the BBS, and can differ from the
  34. **                          real name as it appear locally for you.
  35. **                          Can be the full filename with path, in that case
  36. **                          the filename will be extracted from the path
  37. **                          and used alone.
  38. **
  39. **    LOCALFILENAME=LFILE/K
  40. **                        - The full path and name of the file, used on 
  41. **                          UPLOAD events.
  42. **
  43. **    NOTIFICATION=NOTE/S/K
  44. **                        - Flag that can be set if you want notification
  45. **                          on downloads on a file you UPLOAD.
  46. **
  47. **    FILEDESCRIPTION=DESCR/K
  48. **                        - Short file description on a file you UPLOAD.
  49. **
  50. **    I=INFO/K            - An optional file to be added as long 
  51. **                          file description on UPLOAD.
  52. **    COMMANDSTRING=CMD/K    - A string to be executed by the script. Might
  53. **                          e.g. be a Sysop command or any other command
  54. **                          not supported directly in THOR.
  55. **    BOOLEAN=BOOL/S        - Used by some event types. If present, the 
  56. **                          flag for an event type will be TRUE, else 
  57. **                          FALSE.
  58. **    FROMMSGNR/N/K        - A message number to start some operation on a BBS.
  59. **                          (currently not supported in any script).
  60. **    TOMSGNR/N/K            - A message number to end some operation on a BBS.
  61. **                          (currently not supported in any script).
  62. **
  63. **
  64. **
  65. **    The following event types can be given with the EVENT argument:
  66. **
  67. **    ENTERMSG            - Enter a new message.
  68. **    REPLYMSG            - Reply to a already existing message in the
  69. **                          message database in THOR.
  70. **    JOINCONF            - Join a conference.
  71. **    RESIGNCONF            - Resign from a conference.
  72. **    DOWNLOAD            - Download a file.
  73. **    UPLOAD                - Upload a file.
  74. **    GETCONFLIST            - Get conference list.
  75. **    CONFIGUREBBS        - Configure BBS (from a script if the script 
  76. **                          supports this event).
  77. **    SENDUSERINFO        - Send user information about yourself.
  78. **    GETMESSAGES            - Get messages in CONF starting with FROMMSGNR
  79. **                        - and ending with TOMSGNR.
  80. **    GETNEWFILES            - Include a list of new files.
  81. **    DOCOMMAND            - Execute a custom command
  82. **    AUTOLOGOFF          - If the BOOLEAN flag is present, this event will
  83. **                          log you out of the BBS after the script is 
  84. **                          finished, else will not log you out. 
  85. **                          
  86. **
  87. **    If you are in doubt about what arguments are required for each event,
  88. **  read the "Technical descriptions" chapter on the manual and look
  89. **    at each of the BBS types and their event definitions in the THOR:s/ 
  90. **    directory.  If an argument is given that is not required or optional
  91. **    for the event, THOR will simply ignore it. However, if you leave out
  92. **    an argument THOR needs to add the event, ADDEVENT will return
  93. **    10 in RC.  
  94. **
  95. **
  96. */
  97.  
  98.